DATAMONGO-1849 - Resolve JsonSchema from domain type. #733
+1,634
−350
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JsonSchemaCreator extracts the MongoJsonSchema for a given Class by applying the following mapping rules:
Required Properties:
- All Constructor arguments annotated with Nullable.
- Properties of primitive type.
Ignored Properties:
- All properties annotated with Transient.
Property Type Mapping:
- java.lang.Object -> { type : 'object' }
- java.util.Arrays -> { type : 'array' }
- java.util.Collection -> { type : 'array'}
- java.util.Map -> { type : 'object'}
- java.lang.Enum -> { type : 'string', enum : [ ... ] }
- Simple Types -> { type : 'the corresponding bson type' }
- Domain Types -> { type : 'object', properties : { ... } }
_id properties using types that can be converted into
ObjectId like String will be mapped to { type : 'object' } unless there is more specific information available via the MongoId annotation.
christophstrobl
force-pushed
the
issue/DATAMONGO-1849
branch
from
47bb7a7 to
cd9d764
Compare
By using Field#targetType it is now possible to pass down a type hint to the conversion subsystem. This allows specifying the desired target type for a property so that eg. a plain String can be stored as Code.
christophstrobl
force-pushed
the
issue/DATAMONGO-1849
branch
from
0468059 to
c9097c9
Compare
mp911de
reviewed
Apr 8, 2019
|
|
||
| private boolean isRequiredProperty(PersistentEntity<?, ?> parent, PersistentProperty property) { | ||
|
|
||
| return (parent.isConstructorArgument(property) && !property.isAnnotationPresent(Nullable.class)) |
There was a problem hiding this comment.
See NullableUtils: Properties are nullable by default. Annotating a package with @NonNullApi or @NonNullFields switches to non-null by default.
| * @param mongoConverter must not be {@literal null}. | ||
| * @return new instance of {@link MongoJsonSchemaCreator}. | ||
| */ | ||
| default MongoJsonSchemaCreator jsonSchemaCreator(MongoConverter mongoConverter) { |
| @@ -1667,4 +1689,91 @@ private static boolean isCollectionOfDbRefWhereBulkFetchIsPossible(Iterable<?> s | |||
| return null; | |||
| } | |||
| } | |||
|
|
|||
| private static class HijackedTypeInformation<S> implements TypeInformation<S> { | |||
There was a problem hiding this comment.
How about TypeInformationWrapper 😬and handling the rest of customizations in a separated, smaller type?
| * @return never {@literal null}. | ||
| * @since 2.2 | ||
| */ | ||
| default Class<?> computeWriteTarget(Class<?> source) { |
There was a problem hiding this comment.
We should improve either on the definition or on the implementation of this method. Right now, we could assume that the write target is either a native Mongo type or the write target is an to be converted type.
The number of exposed methods via MongoWriter and MongoConverter keeps constantly increasing and I'm not sure how to think about it.
Fix generics usage in MappingMongoJsonSchemaCreator. Make fields final. Rename MappingMongoConverter.computeWriteTarget to getWriteTarget and expose it publicly for reuse in custom DefaultTypeMapper setups without the need to subclass MappingMongoConverter. Remove Nullability functionality for required fields as nullability indicators should originate from PersistentProperty and PreferredConstructor. Related ticket: DATACMNS-1513
mp911de
pushed a commit
that referenced
this pull request
Apr 9, 2019
MongoJsonSchemaCreator extracts the MongoJsonSchema for a given Class by applying the following mapping rules:
Required Properties:
- Properties of primitive type.
Ignored Properties:
- All properties annotated with Transient.
Property Type Mapping:
- java.lang.Object -> { type : 'object' }
- java.util.Arrays -> { type : 'array' }
- java.util.Collection -> { type : 'array'}
- java.util.Map -> { type : 'object'}
- java.lang.Enum -> { type : 'string', enum : [ ... ] }
- Simple Types -> { type : 'the corresponding bson type' }
- Domain Types -> { type : 'object', properties : { ... } }
_id properties using types that can be converted into
ObjectId like String will be mapped to { type : 'object' } unless there is more specific information available via the MongoId annotation.
By using Field#targetType it is now possible to pass down a type hint to the conversion subsystem. This allows specifying the desired target type for a property so that eg. a plain String can be stored as Code.
Original pull request: #733.
mp911de
added a commit
that referenced
this pull request
Apr 9, 2019
Fix generics usage in MappingMongoJsonSchemaCreator. Make fields final. Rename MappingMongoConverter.computeWriteTarget to getWriteTarget and expose it publicly for reuse in custom DefaultTypeMapper setups without the need to subclass MappingMongoConverter. Remove Nullability functionality for required fields as nullability indicators should originate from PersistentProperty and PreferredConstructor. Update documentation. Related ticket: DATACMNS-1513 Original pull request: #733.
|
That's merged and polished now. |
mariusleu
reviewed
Oct 2, 2024
| @@ -75,7 +76,9 @@ static Collection<Object> getConvertersToRegister() { | |||
| List<Object> converters = new ArrayList<>(); | |||
|
|
|||
| converters.add(BigDecimalToStringConverter.INSTANCE); | |||
| converters.add(BigDecimalToDecimal128Converter.INSTANCE); | |||
There was a problem hiding this comment.
This has no effect, as BigDecimalToStringConverter.INSTANCE from above always takes precedence. All BigDecimal end up as String in the database.
Why do we still need BigDecimalToStringConverter?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
JsonSchemaCreatorextracts theMongoJsonSchemafor a givenClassby applying the following mapping rules:Required Properties
Ignored Properties
Property Type Mapping:
{ type : 'object' }{ type : 'array' }{ type : 'array'}{ type : 'object'}{ type : 'string', enum : [ ... ] }{ type : 'the corresponding bson type' }{ type : 'object', properties : { ... } }_idproperties using types that can be converted intoObjectIdlikeStringwill be mapped to{ type : 'object' }unless there is more specific information available via theMongoIdannotation.